<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaVconnectionHub: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="virtual_connection.html" title="Virtual connections">
<link rel="prev" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">
<link rel="next" href="GdaLdapConnection.html" title="GdaLdapConnection">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaVconnectionHub.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaVconnectionHub.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
                  <a href="#GdaVconnectionHub.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="virtual_connection.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GdaVconnectionDataModel.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaLdapConnection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaVconnectionHub"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaVconnectionHub.top_of_page"></a>GdaVconnectionHub</span></h2>
<p>GdaVconnectionHub — Virtual connection which bind together connections</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaVconnectionHub.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="GdaVconnectionHub.html#GdaVConnectionHubFunc" title="GdaVConnectionHubFunc ()">*GdaVConnectionHubFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-add" title="gda_vconnection_hub_add ()">gda_vconnection_hub_add</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-remove" title="gda_vconnection_hub_remove ()">gda_vconnection_hub_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-get-connection" title="gda_vconnection_hub_get_connection ()">gda_vconnection_hub_get_connection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-foreach" title="gda_vconnection_hub_foreach ()">gda_vconnection_hub_foreach</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GdaVconnectionHub.html#GdaVconnectionHub-struct" title="struct GdaVconnectionHub">GdaVconnectionHub</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a>
        <span class="lineart">╰──</span> <a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection">GdaVirtualConnection</a>
            <span class="lineart">╰──</span> <a class="link" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">GdaVconnectionDataModel</a>
                <span class="lineart">╰──</span> GdaVconnectionHub
</pre>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaVconnectionHub implements
 <a class="link" href="GdaLockable.html" title="GdaLockable">GdaLockable</a>.</p>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;virtual/gda-ldap-connection.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.description"></a><h2>Description</h2>
<p>The <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> object "binds" together the tables from other (opened) connections to make it possible to run
SQL queries on data from several connections at once.</p>
<p>A <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection can bind several other connections, each separated in its own namespace (which is specified
when adding a connection using <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-add" title="gda_vconnection_hub_add ()"><code class="function">gda_vconnection_hub_add()</code></a>).</p>
<p>For example if a connection A has two tables 'table_1' and 'table_2', then after <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-add" title="gda_vconnection_hub_add ()"><code class="function">gda_vconnection_hub_add()</code></a> has been called
with A as connection argument and with a "c1" namespace, then in the corresponding <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection, table 
'table_1' must be referred to as 'c1.table_1' and 'table_2' must be referred to as 'c1.table_2'.</p>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="GdaVConnectionHubFunc"></a><h3>GdaVConnectionHubFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
<span class="c_punctuation">(</span>*GdaVConnectionHubFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
                          <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>,
                          <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-add"></a><h3>gda_vconnection_hub_add ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_vconnection_hub_add (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
                         <em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>,
                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Make all the tables of <em class="parameter"><code>cnc</code></em>
 appear as tables (of the same name) in the <em class="parameter"><code>hub</code></em>
 connection.
If the <em class="parameter"><code>ns</code></em>
 is not <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then within <em class="parameter"><code>hub</code></em>
, the tables will be accessible using the '<em class="parameter"><code>ns</code></em>
.<em class="parameter"><code>table_name</code></em>
'
notation.</p>
<p>Within any instance of <em class="parameter"><code>hub</code></em>
, there can be only one added connection where <em class="parameter"><code>ns</code></em>
 is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gda-vconnection-hub-add.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>hub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ns</p></td>
<td class="parameter_description"><p>a namespace, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-vconnection-hub-add.returns"></a><h4>Returns</h4>
<p> TRUE if no error occurred</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-remove"></a><h3>gda_vconnection_hub_remove ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_vconnection_hub_remove (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
                            <em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Remove all the tables in <em class="parameter"><code>hub</code></em>
 representing <em class="parameter"><code>cnc</code></em>
's tables.</p>
<div class="refsect3">
<a name="gda-vconnection-hub-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>hub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cnc</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-vconnection-hub-remove.returns"></a><h4>Returns</h4>
<p> TRUE if no error occurred</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-get-connection"></a><h3>gda_vconnection_hub_get_connection ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> *
gda_vconnection_hub_get_connection (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
                                    <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>);</pre>
<p>Find the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object in <em class="parameter"><code>hub</code></em>
 associated to the <em class="parameter"><code>ns</code></em>
 name space</p>
<div class="refsect3">
<a name="gda-vconnection-hub-get-connection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>hub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ns</p></td>
<td class="parameter_description"><p>a name space, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-vconnection-hub-get-connection.returns"></a><h4>Returns</h4>
<p> the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a>, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no connection is associated to <em class="parameter"><code>ns</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-foreach"></a><h3>gda_vconnection_hub_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_vconnection_hub_foreach (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
                             <em class="parameter"><code><a class="link" href="GdaVconnectionHub.html#GdaVConnectionHubFunc" title="GdaVConnectionHubFunc ()"><span class="type">GdaVConnectionHubFunc</span></a> func</code></em>,
                             <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>Call <em class="parameter"><code>func</code></em>
 for each <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> represented in <em class="parameter"><code>hub</code></em>
.</p>
<div class="refsect3">
<a name="gda-vconnection-hub-foreach.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>hub</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>func</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaVconnectionDataModel.html#GdaVconnectionDataModelFunc" title="GdaVconnectionDataModelFunc ()"><span class="type">GdaVconnectionDataModelFunc</span></a> function pointer</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>data to pass to <em class="parameter"><code>func</code></em>
calls</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaVconnectionHub-struct"></a><h3>struct GdaVconnectionHub</h3>
<pre class="programlisting">struct GdaVconnectionHub;</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>